From 77a1b245db041feacf4525f8871ae6580705f026 Mon Sep 17 00:00:00 2001
From: tsteven4 <13596209+tsteven4@users.noreply.github.com>
Date: Thu, 27 Oct 2022 16:00:59 -0600
Subject: [PATCH] clean up makedoc with perltidy.

among other issues the indentation was insconsistent, and sometimes
just flat out misleading.

This establishes our perl style as that provided by the defaults
with perltidy.
---
 xmldoc/makedoc | 330 ++++++++++++++++++++++++-------------------------
 1 file changed, 165 insertions(+), 165 deletions(-)

diff --git a/xmldoc/makedoc b/xmldoc/makedoc
index 2b8ef3b0d..845ea4392 100755
--- a/xmldoc/makedoc
+++ b/xmldoc/makedoc
@@ -7,92 +7,92 @@
 @options;
 
 sub expandrw {
-   my $read = shift;
-   my $write = shift;
-   my $type = shift;
-
-   my $res = "";
-   if ( ($read eq 'r') || ($write eq 'w')) {
-     $res .= "      <listitem>\n        <para role=\"fmtcapsitem\">\n          ";
-     if ( ($read eq 'r') && ($write eq 'w')) {
-       $res .= "read and write $type";
-     }
-     elsif ( $read eq 'r' ) {
-       $res .= "read $type";
-     }
-     elsif ( $write eq 'w' ) {
-       $res .= "write $type";
-     }
-     $res .= "\n        </para>\n      </listitem>\n";
-   }
-   $res;
+    my $read  = shift;
+    my $write = shift;
+    my $type  = shift;
+
+    my $res = "";
+    if ( ( $read eq 'r' ) || ( $write eq 'w' ) ) {
+        $res .=
+          "      <listitem>\n        <para role=\"fmtcapsitem\">\n          ";
+        if ( ( $read eq 'r' ) && ( $write eq 'w' ) ) {
+            $res .= "read and write $type";
+        }
+        elsif ( $read eq 'r' ) {
+            $res .= "read $type";
+        }
+        elsif ( $write eq 'w' ) {
+            $res .= "write $type";
+        }
+        $res .= "\n        </para>\n      </listitem>\n";
+    }
+    $res;
 }
 
 sub expandoptions {
-   my $opts = shift;
-   my $res = "  <para role=\"fmtcapshdr\">\n    This format can...\n    <itemizedlist>\n";
+    my $opts = shift;
+    my $res =
+"  <para role=\"fmtcapshdr\">\n    This format can...\n    <itemizedlist>\n";
 
-   $res .= expandrw( substr($opts,0,1), substr($opts,1,1), 'waypoints' );
-   $res .= expandrw( substr($opts,2,1), substr($opts,3,1), 'tracks' );
-   $res .= expandrw( substr($opts,4,1), substr($opts,5,1), 'routes' );
+    $res .=
+      expandrw( substr( $opts, 0, 1 ), substr( $opts, 1, 1 ), 'waypoints' );
+    $res .= expandrw( substr( $opts, 2, 1 ), substr( $opts, 3, 1 ), 'tracks' );
+    $res .= expandrw( substr( $opts, 4, 1 ), substr( $opts, 5, 1 ), 'routes' );
 
-   $res .= "    </itemizedlist></para>\n";
+    $res .= "    </itemizedlist></para>\n";
 
-   $res;
+    $res;
 }
 
 sub expandsuboptions {
-  my $f = shift;
-  my $res;
-  $olist = $options{$f};
+    my $f = shift;
+    my $res;
+    $olist = $options{$f};
 
-  # If no options, don't clutter things.
-  if ($olist eq "") { return; }
+    # If no options, don't clutter things.
+    if ( $olist eq "" ) { return; }
 
-  # Comma separate the human-readable variation.
-  $olist =~ s/> </>, </g;
+    # Comma separate the human-readable variation.
+    $olist =~ s/> </>, </g;
 
-  $res .= "<para>This format has the following options: ";
-  $res .= $olist;
-  $res .= ".</para>";
+    $res .= "<para>This format has the following options: ";
+    $res .= $olist;
+    $res .= ".</para>";
 
-  $res;
+    $res;
 }
 
-
 sub include {
-   my $name=shift;
-   my $dir2=shift;
-
-   $name2 = $name;
-   $name2 =~ s/-/_/g;
-   $d2 = $dir2;
-   $d2 =~ s:/.*::;
-   $name2 = $d2.'_'.$name2;
-   print PARTS qq(<!ENTITY inc_$name2 SYSTEM "../$dir2/$name.xml">\n);
-   print FILE "\&inc_$name2;\n";
-   if (! -e "$dir/$dir2/$name.xml") {
-     open TMP, ">$dir/$dir2/$name.xml";
-     print TMP "\n";
-     close TMP;
-   }
+    my $name = shift;
+    my $dir2 = shift;
+
+    $name2 = $name;
+    $name2 =~ s/-/_/g;
+    $d2 = $dir2;
+    $d2 =~ s:/.*::;
+    $name2 = $d2 . '_' . $name2;
+    print PARTS qq(<!ENTITY inc_$name2 SYSTEM "../$dir2/$name.xml">\n);
+    print FILE "\&inc_$name2;\n";
+    if ( !-e "$dir/$dir2/$name.xml" ) {
+        open TMP, ">$dir/$dir2/$name.xml";
+        print TMP "\n";
+        close TMP;
+    }
 }
 
 sub includef {
-   my $name=shift;
+    my $name = shift;
 
-   $name2 = $name;
-   $name2 =~ s/-/_/g;
-   print PARTS qq(<!ENTITY inc_$name2 SYSTEM "$name.xml">\n);
-   print FORMATS "\&inc_$name2;\n";
+    $name2 = $name;
+    $name2 =~ s/-/_/g;
+    print PARTS qq(<!ENTITY inc_$name2 SYSTEM "$name.xml">\n);
+    print FORMATS "\&inc_$name2;\n";
 }
 
-
-
 $dir = $0;
 $dir =~ s:/.*$::;
 
-@agdir=`mkdir -p $dir/autogen`;
+@agdir = `mkdir -p $dir/autogen`;
 open PARTS, ">$dir/autogen/_parts.xml";
 print PARTS qq(<!-- This document is automatically generated. -->\n);
 print PARTS qq(<!ENTITY formats SYSTEM "_formats.xml">\n);
@@ -103,114 +103,115 @@ print FORMATS qq(<!-- This document is automatically generated. -->\n);
 
 @formats = `./gpsbabel -^3`;
 
-$going = 0;
+$going     = 0;
 $dooptions = 0;
 
 # Prescan the argument list for options.
 
 for (@formats) {
-   chomp;
-   s/\&/\&amp;/g;
-   s/</\&lt;/g;
-   s/>/\&gt;/g;
-   @line = split "\t";
-
-   if (($line[0] eq 'file') || ($line[0] eq 'serial')) {
-	$fmt = $line[2];
-	# Pennance for earlier sins.  Rename magellan -> magellan1 here.
-	if ($line[4] eq "Magellan serial protocol") {
-	 $fmt = "magellan1";
-	}
-	$skipping = 0;
-   }
-   if ( $line[0] eq 'internal' || $line[5] eq 'xcsv') {
-	$skipping = 1;
-   }
-   if ($line[0] eq 'option' && $skipping == 0) {
-     $optname = $line[2];
-
-     $options{$fmt} .= "<link linkend=\"fmt_${fmt}_o_${optname}\">$optname</link> ";
-   }
+    chomp;
+    s/\&/\&amp;/g;
+    s/</\&lt;/g;
+    s/>/\&gt;/g;
+    @line = split "\t";
+
+    if ( ( $line[0] eq 'file' ) || ( $line[0] eq 'serial' ) ) {
+        $fmt = $line[2];
+
+        # Pennance for earlier sins.  Rename magellan -> magellan1 here.
+        if ( $line[4] eq "Magellan serial protocol" ) {
+            $fmt = "magellan1";
+        }
+        $skipping = 0;
+    }
+    if ( $line[0] eq 'internal' || $line[5] eq 'xcsv' ) {
+        $skipping = 1;
+    }
+    if ( $line[0] eq 'option' && $skipping == 0 ) {
+        $optname = $line[2];
+
+        $options{$fmt} .=
+          "<link linkend=\"fmt_${fmt}_o_${optname}\">$optname</link> ";
+    }
 }
 
-
 for (@formats) {
-   chomp;
-   s/\&/\&amp;/g;
-   s/</\&lt;/g;
-   s/>/\&gt;/g;
-   @line = split "\t";
-
-   if ( $line[0] eq 'internal') {
-     if ($going) {
-       print FILE "</section>\n";
-       close FILE;
-       $going = 0;
-     }
-     if ( $line[5] eq 'xcsv' ) {
-       $line[0] = 'file';
-     }
-   }
-
-   if (($line[0] eq 'file') || ($line[0] eq 'serial')) {
-     if ($going) {
-       print FILE "</section>\n";
-       close FILE;
-     }
-     $id = $line[2];
-     if ( $fmts{$id} ) {
-       $id .= $fmts{$id}++;
-     }
-     else {
-       $fmts{$id} = 1;
-     }
-     includef( 'fmt_'.$id );
-     open FILE, ">$dir/autogen/fmt_$id.xml";
-     print FILE <<END;
+    chomp;
+    s/\&/\&amp;/g;
+    s/</\&lt;/g;
+    s/>/\&gt;/g;
+    @line = split "\t";
+
+    if ( $line[0] eq 'internal' ) {
+        if ($going) {
+            print FILE "</section>\n";
+            close FILE;
+            $going = 0;
+        }
+        if ( $line[5] eq 'xcsv' ) {
+            $line[0] = 'file';
+        }
+    }
+
+    if ( ( $line[0] eq 'file' ) || ( $line[0] eq 'serial' ) ) {
+        if ($going) {
+            print FILE "</section>\n";
+            close FILE;
+        }
+        $id = $line[2];
+        if ( $fmts{$id} ) {
+            $id .= $fmts{$id}++;
+        }
+        else {
+            $fmts{$id} = 1;
+        }
+        includef( 'fmt_' . $id );
+        open FILE, ">$dir/autogen/fmt_$id.xml";
+        print FILE <<END;
 <!-- This document is automatically generated. -->
 <section id="fmt_$id">
   <title>$line[4] ($line[2])</title>
 END
-     print FILE expandoptions($line[1]);
-     print FILE expandsuboptions($id);
-     $going = 1;
-     $dooptions = 1;
-     if ( defined($line[5]) && ($line[5] ne $line[2]) ) {
-       print FILE <<END;
+        print FILE expandoptions( $line[1] );
+        print FILE expandsuboptions($id);
+        $going     = 1;
+        $dooptions = 1;
+
+        if ( defined( $line[5] ) && ( $line[5] ne $line[2] ) ) {
+            print FILE <<END;
 <para>
 This format is derived from the <link linkend="fmt_$line[5]">$line[5]</link>
 format, so it has all of the same options as that format.
 </para>
 END
-       if ($line[5] eq 'xcsv' ) {
-         $dooptions=0;
-       }
-     }
-     include($id,"formats");
-   }
-   elsif ($going && $dooptions && ($line[0] eq 'option')) {
-     $nid = 'fmt_'.$id.'_o_'.$line[2];
-     print FILE <<END;
+            if ( $line[5] eq 'xcsv' ) {
+                $dooptions = 0;
+            }
+        }
+        include( $id, "formats" );
+    }
+    elsif ( $going && $dooptions && ( $line[0] eq 'option' ) ) {
+        $nid = 'fmt_' . $id . '_o_' . $line[2];
+        print FILE <<END;
   <section id="$nid">
     <title><option>$line[2]</option> option</title>
     <para>
       $line[3].
     </para>
 END
-     include($id.'-'.$line[2],"formats/options");
-     print FILE <<END;
+        include( $id . '-' . $line[2], "formats/options" );
+        print FILE <<END;
   </section>
 END
-   }
+    }
 }
 
 if ($going) {
-  print FILE "</section>\n";
-  close FILE;
-  $going = 0;
+    print FILE "</section>\n";
+    close FILE;
+    $going = 0;
 }
 
-
 open FORMATS, ">$dir/autogen/_filters.xml";
 print FORMATS qq(<!-- This document is automatically generated. -->\n);
 
@@ -219,47 +220,46 @@ print FORMATS qq(<!-- This document is automatically generated. -->\n);
 $going = 0;
 
 for (@filters) {
-   chomp;
-   s/\&/\&amp;/g;
-   s/</\&lt;/g;
-   s/>/\&gt;/g;
-   @line = split "\t";
-
-   if ($going && ($line[0] eq 'option')) {
-     print FILE <<END;
+    chomp;
+    s/\&/\&amp;/g;
+    s/</\&lt;/g;
+    s/>/\&gt;/g;
+    @line = split "\t";
+
+    if ( $going && ( $line[0] eq 'option' ) ) {
+        print FILE <<END;
   <section id="fmt_$line[1]_o_$line[2]">
     <title>$line[2] option</title>
     <para>
       $line[3].
     </para>
 END
-     include($line[1].'-'.$line[2],"filters/options");
-     print FILE <<END;
+        include( $line[1] . '-' . $line[2], "filters/options" );
+        print FILE <<END;
   </section>
 END
-   }
-   else {
-     if ($going) {
-       print FILE "</section>\n";
-       close FILE;
-     }
-     includef( 'filter_'.$line[0] );
-     open FILE, ">$dir/autogen/filter_$line[0].xml";
-     print FILE <<END;
+    }
+    else {
+        if ($going) {
+            print FILE "</section>\n";
+            close FILE;
+        }
+        includef( 'filter_' . $line[0] );
+        open FILE, ">$dir/autogen/filter_$line[0].xml";
+        print FILE <<END;
 <!-- This document is automatically generated. -->
 <section id="filter_$line[0]">
   <title>$line[1] ($line[0])</title>
 END
-     include($line[0],"filters");
-     $going = $line[0];
-   }
+        include( $line[0], "filters" );
+        $going = $line[0];
+    }
 }
 
-
 if ($going) {
-  print FILE "</section>\n";
-  close FILE;
-  $going = 0;
+    print FILE "</section>\n";
+    close FILE;
+    $going = 0;
 }
 close FORMATS;
 close PARTS;
-- 
2.30.2